{{#readmeHeader}}
<div align={{#leftAlignDescription}}"left"{{/leftAlignDescription}}{{^leftAlignDescription}}"center"{{/leftAlignDescription}}>

[![Visit {{{title}}}](https://raw.githubusercontent.com/{{gitUserId}}/{{gitRepoName}}/HEAD{{^isGitSubmodule}}/{{{outputDirectory}}}{{/isGitSubmodule}}/header.png)]({{{url}}})

# [{{{title}}}]({{{url}}})
{{^omitInfoDescription}}

{{{unescapedAppDescription}}}
{{/omitInfoDescription}}

{{> readme_badges}}

</div>
{{/readmeHeader}}
{{^readmeHeader}}
# {{artifactId}}

{{^omitInfoDescription}}{{{unescapedAppDescription}}}
{{/omitInfoDescription}}

{{> readme_badges}}
{{/readmeHeader}}

## Table of Contents

<!-- toc -->

## Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

If you are adding this library to an Android Application or Library:

3. Android 8.0+ (API Level 26+)

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell
mvn clean install
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell
mvn clean deploy
```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
  <groupId>{{{groupId}}}</groupId>
  <artifactId>{{{artifactId}}}</artifactId>
  <version>{{{artifactVersion}}}</version>
  <scope>compile</scope>
</dependency>
```

### Gradle users

Add this dependency to your `build.gradle`:

```groovy
// build.gradle
repositories {
  mavenCentral()
}

dependencies {
   implementation "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
}
```

### Android users

Make sure your `build.gradle` file as a `minSdk` version of at least 26:
```groovy
// build.gradle
android {
    defaultConfig {
        minSdk 26
    }
}
```

Also make sure your library or application has internet permissions in your `AndroidManifest.xml`:

```xml
<!--AndroidManifest.xml-->
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
    <uses-permission android:name="android.permission.INTERNET"/>
</manifest>
```

### Others

At first generate the JAR by executing:

```shell
mvn clean package
```

Then manually install the following JARs:

* `target/{{{artifactId}}}-{{{artifactVersion}}}.jar`
* `target/lib/*.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java
{{#readmeSnippet}}
{{{.}}}
{{/readmeSnippet}}
{{^readmeSnippet}}
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{> libraries/okhttp-gson/api_doc_example}}{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
{{/readmeSnippet}}
```
{{^omitApiDocumentation}}
## Reference

{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}
### `{{{clientNameLowercase}}}.{{> api_doc_example_method}}`
{{#isDeprecated}}
![Deprecated](https://img.shields.io/badge/deprecated-yellow)
{{/isDeprecated}}

{{#notes}}
{{{unescapedNotes}}}

{{/notes}}
{{^notes}}
{{summary}}

{{/notes}}
#### 🛠️ Usage

```java
{{> libraries/okhttp-gson/api_doc_example_call}}
```

{{#hasParams}}
{{#allParamsWithRequestBodyProperties}}
{{#-first}}
#### ⚙️ Parameters

{{/-first}}
{{#operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
##### {{> README_parameter_name}}: {{> api_doc_param_data_type}}

{{> README_parameter_description}}
{{/operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{^operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{^isFromBodyParam}}
##### {{> README_parameter_name}}: {{> api_doc_param_data_type}}

{{> README_parameter_description}}
{{/isFromBodyParam}}
{{/operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{/allParamsWithRequestBodyProperties}}
{{#bodyParam}}
{{^operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
##### requestBody: {{> api_doc_param_data_type}}

{{> README_parameter_description}}
{{/operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{#operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{#isArray}}
#### ⚙️ Request Body

{{> api_doc_param_data_type}}

{{> README_parameter_description}}
{{/isArray}}
{{/operationVendorExtensions.x-konfig-operation-can-have-single-parameter}}
{{/bodyParam}}
{{/hasParams}}
{{#returnModel}}
#### 🔄 Return

[{{{classname}}}](./src/main/java/com/konfigthis/client/model/{{{classFilename}}}.java)

{{/returnModel}}
#### 🌐 Endpoint

`{{path}}` `{{httpMethod}}`

[🔙 **Back to Table of Contents**](#table-of-contents)

---

{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
{{/omitApiDocumentation}}
{{^removeKonfigBranding}}
## Author
This Java package is automatically generated by [Konfig](https://konfigthis.com)
{{/removeKonfigBranding}}
